Repository navigation
Add Zensical docs, and update doc comments - #11
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a documentation site built with Zensical, deployed to GitHub Pages, and documents the fields in the API models.
Docs site
docsdependency group (zensical,mkdocstrings[python]), installed byjust syncjust docsserves the site locally andjust docs-buildruns a strict build intosite/Deploy
.github/workflows/docs.ymlbuilds the docs on pushes and PRs tomain, and deploys to GitHub Pages on pushes tomainand manual runs usingactions/upload-pages-artifactandactions/deploy-pages.Field docstrings
models.py,requests.py,responses.py, andtypes.py: inline#comments became attribute docstrings, and docstrings were added where meaning isn't obvious (pennies, zero dates, product vs. offer IDs, reverse auctions, SKU rules, per-category price meanings, coin grades), checked against the PriceCharting API documentationPriceChartingModelsetsuse_attribute_docstrings=True, so docstrings also become pydantic field descriptionsChangelog removal
CHANGELOG.mdand the changelog step inrelease.yml. GitHub Release notes are now the changelog.Docs updates
README.md,CI.md,RELEASE.md, and the PR template are updated for the docs site, the new workflow, the changelog removal, and corrected details (Dependabot schedule, Python 3.15)Related Issues
None
Type of Change
documentationChecklist
just lintpassesjust testpassesREADME.mdupdated if needed